GET FormTypes?assetTypeId={assetTypeId}&take={take}&skip={skip}&sort[0].Field={sort[0].Field}&sort[0].Dir={sort[0].Dir}&sort[1].Field={sort[1].Field}&sort[1].Dir={sort[1].Dir}
Retrieves form types for the given parameters. All parameters are optional.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
assetTypeId |
Id of the asset type |
globally unique identifier |
None. |
take |
Number of form types to retrieve. Default is all form types |
integer |
None. |
skip |
Number of form types to skip before retrieval |
integer |
Default value is 0 |
sort |
List of sorting rules to describe how to sort the form types before retrieval |
Collection of Sort |
None. |
Operator | string |
None. |
|
Field | string |
None. |
|
Value | string |
None. |
|
Logic | string |
None. |
|
Filters | Collection of Filter |
None. |
Body Parameters
None.
Response Information
Resource Description
On success, a list of form types.
Name | Description | Type | Additional information |
---|---|---|---|
Data | Collection of FormType |
None. |
|
Total | integer |
None. |
|
Message | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Data": [ { "FormTypeId": "b1a15bd2-c23a-44ca-99c1-f8fd4703a698", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a621747e-8e42-4a23-ae1d-2d1641a2305e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "187b1b40-946b-4535-b896-df2305c050d3", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-02T06:21:29.5519414-07:00", "Fields": [ { "FormTypeFieldId": "84918310-e7f8-4f82-bb32-98bb10faa98e", "Section": { "FormTypeSectionId": "38789b37-988f-4e70-97c6-5221ad5ca3bf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "3e4868e5-b171-4411-b58f-6c30eeba9c43", "Name": "sample string 1" }, "Unit": { "UnitId": "f8833c20-cba9-478b-bf2a-3301f08ddfc2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f56e83f4-272f-4595-b569-a035608c22eb", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "84918310-e7f8-4f82-bb32-98bb10faa98e", "Section": { "FormTypeSectionId": "38789b37-988f-4e70-97c6-5221ad5ca3bf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "3e4868e5-b171-4411-b58f-6c30eeba9c43", "Name": "sample string 1" }, "Unit": { "UnitId": "f8833c20-cba9-478b-bf2a-3301f08ddfc2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f56e83f4-272f-4595-b569-a035608c22eb", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "ce146ff2-9cc2-4d33-a37c-cd879d0fdb45", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 6" }, { "FormTypeId": "b1a15bd2-c23a-44ca-99c1-f8fd4703a698", "Name": "sample string 1", "Description": "sample string 2", "AssetType": { "AssetTypeId": "a621747e-8e42-4a23-ae1d-2d1641a2305e", "Name": "sample string 1", "Description": "sample string 2", "DisplayColor": "sample string 3", "SourceSystemId": "sample string 4", "CompanyId": "187b1b40-946b-4535-b896-df2305c050d3", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 6", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 7" }, "FrequencyNeeded": 1, "ValueNeededDate": "2024-05-02T06:21:29.5519414-07:00", "Fields": [ { "FormTypeFieldId": "84918310-e7f8-4f82-bb32-98bb10faa98e", "Section": { "FormTypeSectionId": "38789b37-988f-4e70-97c6-5221ad5ca3bf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "3e4868e5-b171-4411-b58f-6c30eeba9c43", "Name": "sample string 1" }, "Unit": { "UnitId": "f8833c20-cba9-478b-bf2a-3301f08ddfc2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f56e83f4-272f-4595-b569-a035608c22eb", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" }, { "FormTypeFieldId": "84918310-e7f8-4f82-bb32-98bb10faa98e", "Section": { "FormTypeSectionId": "38789b37-988f-4e70-97c6-5221ad5ca3bf", "Name": "sample string 1", "Label": "sample string 2", "DisplayOrder": 1, "IsRepeatable": true, "VisibleExpression": "sample string 4", "SourceSystemId": "sample string 5" }, "Name": "sample string 1", "Label": "sample string 2", "Description": "sample string 3", "DataType": { "DataTypeId": "3e4868e5-b171-4411-b58f-6c30eeba9c43", "Name": "sample string 1" }, "Unit": { "UnitId": "f8833c20-cba9-478b-bf2a-3301f08ddfc2", "Code": "sample string 1", "Description": "sample string 2", "SourceSystemId": "sample string 3", "CompanyId": "f56e83f4-272f-4595-b569-a035608c22eb", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 6" }, "DisplayOrder": 1, "MinValue": 1.0, "MaxValue": 1.0, "MinLength": 1, "MaxLength": 1, "HasValidValues": true, "ValidValues": [ "sample string 1", "sample string 2" ], "ValueExpression": "sample string 5", "RequiredExpression": "sample string 6", "IsAttachment": true, "DefaultValueExpression": "sample string 8", "IsAccumulator": true, "IsMultiline": true, "IsRepeatable": true, "VisibleExpression": "sample string 12", "SourceSystemId": "sample string 13" } ], "SourceSystemId": "sample string 3", "CompanyId": "ce146ff2-9cc2-4d33-a37c-cd879d0fdb45", "CreateDate": "2024-05-02T06:21:29.5519414-07:00", "CreateUser": "sample string 5", "LastModifiedDate": "2024-05-02T06:21:29.5519414-07:00", "LastModifiedUser": "sample string 6" } ], "Total": 1, "Message": "sample string 1" }